<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Enumerated types</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__evtgen__enums.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#enum-members">Enumerations</a>  </div>
  <div class="headertitle">
<div class="title">Enumerated types<div class="ingroups"><a class="el" href="group__group__evtgen.html">EVTGEN       (Event Generator)</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga6ef358e4fea77f7441141ffcd0db24b6"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__evtgen__enums.html#ga6ef358e4fea77f7441141ffcd0db24b6">cy_en_evtgen_status_t</a> { <br />
&#160;&#160;<b>CY_EVTGEN_SUCCESS</b> = 0UL, 
<br />
&#160;&#160;<b>CY_EVTGEN_BAD_PARAM</b>
<br />
 }<tr class="memdesc:ga6ef358e4fea77f7441141ffcd0db24b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies return values meaning.  <a href="group__group__evtgen__enums.html#ga6ef358e4fea77f7441141ffcd0db24b6">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ga6ef358e4fea77f7441141ffcd0db24b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1087cc200d18240cbb5b718d04f209a3"><td class="memItemLeft" align="right" valign="top"><a id="ga1087cc200d18240cbb5b718d04f209a3"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__evtgen__enums.html#ga1087cc200d18240cbb5b718d04f209a3">cy_en_evtgen_counter_status_t</a> { <br />
&#160;&#160;<b>CY_EVTGEN_COUNTER_STATUS_INVALID</b> = 0UL, 
<br />
&#160;&#160;<b>CY_EVTGEN_COUNTER_STATUS_VALID</b> = 1UL
<br />
 }<tr class="memdesc:ga1087cc200d18240cbb5b718d04f209a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the state of the Active Counter in the function Cy_EvtGen_GetCounterStatus. <br /></td></tr>
</td></tr>
<tr class="separator:ga1087cc200d18240cbb5b718d04f209a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae3ae3b797ed9262472524c9a917b3ce6"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__evtgen__enums.html#gae3ae3b797ed9262472524c9a917b3ce6">cy_en_evtgen_ratio_dynamic_mode_t</a> { <br />
&#160;&#160;<a class="el" href="group__group__evtgen__enums.html#ggae3ae3b797ed9262472524c9a917b3ce6aa379d7c1be4d8b61ef8f4a2ba7b9bc74">CY_EVTGEN_RATIO_DYNAMIC_MODE0</a> = 0UL, 
<br />
&#160;&#160;<a class="el" href="group__group__evtgen__enums.html#ggae3ae3b797ed9262472524c9a917b3ce6add53b3c5060ad3a22c06b8d1845a81f6">CY_EVTGEN_RATIO_DYNAMIC_MODE1</a> = 1UL, 
<br />
&#160;&#160;<a class="el" href="group__group__evtgen__enums.html#ggae3ae3b797ed9262472524c9a917b3ce6a35cf86eddefd2be1f3de7e53e63e6aa0">CY_EVTGEN_RATIO_DYNAMIC_MODE2</a> = 2UL, 
<br />
&#160;&#160;<a class="el" href="group__group__evtgen__enums.html#ggae3ae3b797ed9262472524c9a917b3ce6a723f8f03bd0ab15a77486ab692430aa6">CY_EVTGEN_RATIO_DYNAMIC_MODE3</a> = 3UL, 
<br />
&#160;&#160;<a class="el" href="group__group__evtgen__enums.html#ggae3ae3b797ed9262472524c9a917b3ce6a82b99d3a6bd50d61bde221a07aed814b">CY_EVTGEN_RATIO_DYNAMIC_MODE4</a> = 4UL, 
<br />
&#160;&#160;<a class="el" href="group__group__evtgen__enums.html#ggae3ae3b797ed9262472524c9a917b3ce6a831ed82cb25b016bcc75dff9aab18640">CY_EVTGEN_RATIO_DYNAMIC_MODE5</a> = 5UL, 
<br />
&#160;&#160;<a class="el" href="group__group__evtgen__enums.html#ggae3ae3b797ed9262472524c9a917b3ce6a406d3041c47fc0679b73fb46043ab61c">CY_EVTGEN_RATIO_DYNAMIC_MODE6</a> = 6UL, 
<br />
&#160;&#160;<a class="el" href="group__group__evtgen__enums.html#ggae3ae3b797ed9262472524c9a917b3ce6a1d95bebd4d81d6a1e4e70618dc3570dd">CY_EVTGEN_RATIO_DYNAMIC_MODE7</a> = 7UL
<br />
 }<tr class="memdesc:gae3ae3b797ed9262472524c9a917b3ce6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ratio Value Dynamic Mode.  <a href="group__group__evtgen__enums.html#gae3ae3b797ed9262472524c9a917b3ce6">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:gae3ae3b797ed9262472524c9a917b3ce6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4461ea1a58eded2d77ab335791b7bc30"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__evtgen__enums.html#ga4461ea1a58eded2d77ab335791b7bc30">cy_en_evtgen_ratio_control_t</a> { <br />
&#160;&#160;<a class="el" href="group__group__evtgen__enums.html#gga4461ea1a58eded2d77ab335791b7bc30a3a68493060dd7beee2d50cfd53d35eb2">CY_EVTGEN_RATIO_CONTROL_SW</a> = 0UL, 
<br />
&#160;&#160;<a class="el" href="group__group__evtgen__enums.html#gga4461ea1a58eded2d77ab335791b7bc30a4619fe6b43b8415c02dec0a173f90123">CY_EVTGEN_RATIO_CONTROL_HW</a> = 1UL
<br />
 }<tr class="memdesc:ga4461ea1a58eded2d77ab335791b7bc30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set Ratio Control Mode.  <a href="group__group__evtgen__enums.html#ga4461ea1a58eded2d77ab335791b7bc30">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ga4461ea1a58eded2d77ab335791b7bc30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa355fbf8032734ea3fa3719c99878dae"><td class="memItemLeft" align="right" valign="top"><a id="gaa355fbf8032734ea3fa3719c99878dae"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__evtgen__enums.html#gaa355fbf8032734ea3fa3719c99878dae">cy_en_evtgen_struct_trigger_t</a> { <br />
&#160;&#160;<b>CY_EVTGEN_LEVEL_SENSITIVE</b> = 0UL, 
<br />
&#160;&#160;<b>CY_EVTGEN_EDGE_SENSITIVE</b>
<br />
 }<tr class="memdesc:gaa355fbf8032734ea3fa3719c99878dae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set Trigger Mode. <br /></td></tr>
</td></tr>
<tr class="separator:gaa355fbf8032734ea3fa3719c99878dae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga604df187d299595948bfdf3762e18b5c"><td class="memItemLeft" align="right" valign="top"><a id="ga604df187d299595948bfdf3762e18b5c"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__evtgen__enums.html#ga604df187d299595948bfdf3762e18b5c">cy_en_evtgen_struct_functionality_t</a> { <br />
&#160;&#160;<b>CY_EVTGEN_ACTIVE_FUNCTIONALITY</b> = 0UL, 
<br />
&#160;&#160;<b>CY_EVTGEN_DEEPSLEEP_FUNCTIONALITY</b>
<br />
 }<tr class="memdesc:ga604df187d299595948bfdf3762e18b5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set Work Mode of Comparator Structure. <br /></td></tr>
</td></tr>
<tr class="separator:ga604df187d299595948bfdf3762e18b5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga6ef358e4fea77f7441141ffcd0db24b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6ef358e4fea77f7441141ffcd0db24b6">&#9670;&nbsp;</a></span>cy_en_evtgen_status_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__group__evtgen__enums.html#ga6ef358e4fea77f7441141ffcd0db24b6">cy_en_evtgen_status_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Specifies return values meaning. </p>
<p>This enum has the return values of the Event generator driver </p>

</div>
</div>
<a id="gae3ae3b797ed9262472524c9a917b3ce6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae3ae3b797ed9262472524c9a917b3ce6">&#9670;&nbsp;</a></span>cy_en_evtgen_ratio_dynamic_mode_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__group__evtgen__enums.html#gae3ae3b797ed9262472524c9a917b3ce6">cy_en_evtgen_ratio_dynamic_mode_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Ratio Value Dynamic Mode. </p>
<p>Ratio calculation is based on a weighted average operation. This enum has the setting weight for calculation.</p>
<dl class="section note"><dt>Note</dt><dd>Small weights coefficients respond more quickly to changes in the number of clk_ref_div cycles per clk_lf cycle than larger weights coefficients. Use the small dynamic ratio values in the cause low-precision of the low-frequency clock or in difficult operating conditions (eg high temperature). </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggae3ae3b797ed9262472524c9a917b3ce6aa379d7c1be4d8b61ef8f4a2ba7b9bc74"></a>CY_EVTGEN_RATIO_DYNAMIC_MODE0&#160;</td><td class="fielddoc"><p>new RATIO value = (RATIO + measurement + 1) / 2. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae3ae3b797ed9262472524c9a917b3ce6add53b3c5060ad3a22c06b8d1845a81f6"></a>CY_EVTGEN_RATIO_DYNAMIC_MODE1&#160;</td><td class="fielddoc"><p>new RATIO value = (3*RATIO + measurement + 2) / 4. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae3ae3b797ed9262472524c9a917b3ce6a35cf86eddefd2be1f3de7e53e63e6aa0"></a>CY_EVTGEN_RATIO_DYNAMIC_MODE2&#160;</td><td class="fielddoc"><p>new RATIO value = (7*RATIO + measurement + 4) / 8. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae3ae3b797ed9262472524c9a917b3ce6a723f8f03bd0ab15a77486ab692430aa6"></a>CY_EVTGEN_RATIO_DYNAMIC_MODE3&#160;</td><td class="fielddoc"><p>new RATIO value = (15*RATIO + measurement + 8) / 16. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae3ae3b797ed9262472524c9a917b3ce6a82b99d3a6bd50d61bde221a07aed814b"></a>CY_EVTGEN_RATIO_DYNAMIC_MODE4&#160;</td><td class="fielddoc"><p>new RATIO value = (31*RATIO + measurement + 16) / 32. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae3ae3b797ed9262472524c9a917b3ce6a831ed82cb25b016bcc75dff9aab18640"></a>CY_EVTGEN_RATIO_DYNAMIC_MODE5&#160;</td><td class="fielddoc"><p>new RATIO value = (63*RATIO + measurement + 32) / 64. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae3ae3b797ed9262472524c9a917b3ce6a406d3041c47fc0679b73fb46043ab61c"></a>CY_EVTGEN_RATIO_DYNAMIC_MODE6&#160;</td><td class="fielddoc"><p>new RATIO value = (127*RATIO + measurement + 64) / 128. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae3ae3b797ed9262472524c9a917b3ce6a1d95bebd4d81d6a1e4e70618dc3570dd"></a>CY_EVTGEN_RATIO_DYNAMIC_MODE7&#160;</td><td class="fielddoc"><p>new RATIO value = (255*RATIO + measurement + 128) / 256. </p>
</td></tr>
</table>

</div>
</div>
<a id="ga4461ea1a58eded2d77ab335791b7bc30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4461ea1a58eded2d77ab335791b7bc30">&#9670;&nbsp;</a></span>cy_en_evtgen_ratio_control_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__group__evtgen__enums.html#ga4461ea1a58eded2d77ab335791b7bc30">cy_en_evtgen_ratio_control_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set Ratio Control Mode. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga4461ea1a58eded2d77ab335791b7bc30a3a68493060dd7beee2d50cfd53d35eb2"></a>CY_EVTGEN_RATIO_CONTROL_SW&#160;</td><td class="fielddoc"><p>The ratio value is static and calculated during the initialization of the Event Generator. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga4461ea1a58eded2d77ab335791b7bc30a4619fe6b43b8415c02dec0a173f90123"></a>CY_EVTGEN_RATIO_CONTROL_HW&#160;</td><td class="fielddoc"><p>Autocalibration continuously measures the number of clk_ref_div cycles per clk_lf cycle and combines this new measurement with the current RATIO value to calculate the new RATIO value. </p>
</td></tr>
</table>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
